Skip to content

docs: restructure compute docs and add jobs documentation - #4518

Open
andre-code wants to merge 21 commits into
masterfrom
feat/job-docs-content
Open

docs: restructure compute docs and add jobs documentation#4518
andre-code wants to merge 21 commits into
masterfrom
feat/job-docs-content

Conversation

@andre-code

@andre-code andre-code commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Reorganizes user docs from Sessions into a concept-first Launchers & Compute section
  • Adds new Job documentation (launcher, submit, monitor/cancel/dismiss jobs)
  • Groups existing guides under Environment, Session, Job and Apps
  • Updates content and links across docs to reflect the new UI with job launchers

New documentation structure

Launchers & Compute/
├── Launcher
├── Resource Pools & Classes
│
├── Environment/
│   ├── Environment (concept)
│   └── How to...
│       ├── Create environment with custom packages installed
│       ├── Create environment from private code repository
│       ├── Use your own docker image
│       └── Configure front ends for a session environment
│
├── Sessions/
│   ├── Session (concept)
│   └── How to...
│       ├── Add a session launcher
│       ├── CSCS integration
│       ├── Install packages on-the-fly
│       ├── Connect from local VSCode
│       └── Share a session launch link
│
├── Jobs/
│   ├── Job (concept)
│   └── How to...
│       ├── Add a job launcher
│       ├── Submit a job
│       ├── Monitor, cancel, and dismiss jobs
│       └── Handle long training runs
│
├── Apps/
│   └── How to...
│       ├── Set up Shiny app launcher
│       ├── Custom environment + launcher for Shiny
│       └── Create Streamlit app
│
├── Alerts/ (collapsed in sidebar)
│   ├── High Memory Usage
│   ├── Session Restarted (OOM)
│   └── Low Disk Space
│
└── How to... (cross-cutting)
    ├── Select compute resources
    └── Configure a session secret

@RenkuBot

Copy link
Copy Markdown
Collaborator

You can access the deployment of this PR at https://ci-renku-4518.dev.renku.ch

@andre-code andre-code changed the title feat: update docs to add job docs: restructure compute docs and add jobs documentation Jul 10, 2026
@andre-code
andre-code marked this pull request as ready for review July 10, 2026 11:02
@andre-code
andre-code requested a review from a team as a code owner July 10, 2026 11:02
@andre-code
andre-code marked this pull request as draft July 10, 2026 11:03
eikek
eikek previously approved these changes Jul 10, 2026

@eikek eikek left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! 🎉

Base automatically changed from feat/add-jobs to release-2.19.0 July 13, 2026 09:11
Base automatically changed from release-2.19.0 to master July 13, 2026 11:17
@olevski
olevski dismissed eikek’s stale review July 13, 2026 11:17

The base branch was changed.

@lokijuhy lokijuhy left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is coming together very nicely! The docs for jobs themselves are spot on- I don't think I had any comments there. Just a few notes on adjustments for all the shuffling around of existing docs. Thank you!

Comment thread docs/docs/10-users/60-compute/40-environment/index.md Outdated
bethcg added a commit that referenced this pull request Jul 20, 2026
bethcg added a commit that referenced this pull request Jul 20, 2026
@bethcg
bethcg marked this pull request as ready for review July 20, 2026 12:40
@bethcg
bethcg requested review from a team as code owners July 20, 2026 12:40
rokroskar pushed a commit that referenced this pull request Jul 28, 2026
rokroskar pushed a commit that referenced this pull request Jul 28, 2026
@rokroskar
rokroskar force-pushed the feat/job-docs-content branch from 7c6d5b1 to 9ee926e Compare July 28, 2026 15:21
@rokroskar

Copy link
Copy Markdown
Member

I rebased on current master branch and made some wording edits.

@rokroskar
rokroskar force-pushed the feat/job-docs-content branch from 1492ffd to 1d84659 Compare July 28, 2026 16:53
@rokroskar
rokroskar requested a review from lokijuhy July 28, 2026 17:01
@rokroskar
rokroskar force-pushed the feat/job-docs-content branch from 1d84659 to 73fd943 Compare July 28, 2026 17:04
@rokroskar
rokroskar force-pushed the feat/job-docs-content branch from 73fd943 to af6593a Compare July 28, 2026 17:08
rokroskar
rokroskar previously approved these changes Jul 28, 2026

@rokroskar rokroskar left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks all! I think the new structure looks really good!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants